<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>AssertArchitectureTask xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/com/seventytwomiles/architecturerules/ant/AssertArchitectureTask.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * Copyright 2007 the original author or authors.</em>
<a name="3" href="#3">3</a>   <em> *</em>
<a name="4" href="#4">4</a>   <em> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> *         <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em> *</em>
<a name="10" href="#10">10</a>  <em> * For more information visit</em>
<a name="11" href="#11">11</a>  <em> *         <a href="http://72miles.com" target="alexandria_uri">http://72miles.com</a> and</em>
<a name="12" href="#12">12</a>  <em> *         <a href="http://architecturerules.googlecode.com/svn/docs/index.html" target="alexandria_uri">http://architecturerules.googlecode.com/svn/docs/index.html</a></em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> com.seventytwomiles.architecturerules.ant;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong>import</strong> com.seventytwomiles.architecturerules.configuration.Configuration;
<a name="19" href="#19">19</a>  <strong>import</strong> com.seventytwomiles.architecturerules.configuration.ConfigurationFactory;
<a name="20" href="#20">20</a>  <strong>import</strong> com.seventytwomiles.architecturerules.configuration.UnmodifiableConfiguration;
<a name="21" href="#21">21</a>  <strong>import</strong> com.seventytwomiles.architecturerules.configuration.xml.DigesterConfigurationFactory;
<a name="22" href="#22">22</a>  <strong>import</strong> com.seventytwomiles.architecturerules.services.CyclicRedundancyService;
<a name="23" href="#23">23</a>  <strong>import</strong> com.seventytwomiles.architecturerules.services.CyclicRedundancyServiceImpl;
<a name="24" href="#24">24</a>  <strong>import</strong> com.seventytwomiles.architecturerules.services.RulesService;
<a name="25" href="#25">25</a>  <strong>import</strong> com.seventytwomiles.architecturerules.services.RulesServiceImpl;
<a name="26" href="#26">26</a>  <strong>import</strong> org.apache.tools.ant.BuildException;
<a name="27" href="#27">27</a>  <strong>import</strong> org.apache.tools.ant.Task;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  
<a name="30" href="#30">30</a>  
<a name="31" href="#31">31</a>  <em>/**<em>*</em></em>
<a name="32" href="#32">32</a>  <em> * &lt;p>Ant task to assert architecture.&lt;/p></em>
<a name="33" href="#33">33</a>  <em> *</em>
<a name="34" href="#34">34</a>  <em> * &lt;p>Usage looks like:&lt;/p></em>
<a name="35" href="#35">35</a>  <em> *</em>
<a name="36" href="#36">36</a>  <em> * &lt;pre></em>
<a name="37" href="#37">37</a>  <em> * &amp;lt;taskdef name="assertArchitecture"</em>
<a name="38" href="#38">38</a>  <em> *          classname="com.seventytwomiles.architecturerules.ant.AssertArchitectureTask"></em>
<a name="39" href="#39">39</a>  <em> *    &amp;lt;classpath refid="class.path"/></em>
<a name="40" href="#40">40</a>  <em> * &amp;lt;/taskdef></em>
<a name="41" href="#41">41</a>  <em> *</em>
<a name="42" href="#42">42</a>  <em> * &amp;lt;target name="assert-architecture" depends="compile"></em>
<a name="43" href="#43">43</a>  <em> *    &amp;lt;assertArchitecture configurationFileName="architecture-rules-pass.xml"/></em>
<a name="44" href="#44">44</a>  <em> * &amp;lt;/target></em>
<a name="45" href="#45">45</a>  <em> * &lt;/pre></em>
<a name="46" href="#46">46</a>  <em> *</em>
<a name="47" href="#47">47</a>  <em> * &lt;p>Requires the optional dependency&lt;/p></em>
<a name="48" href="#48">48</a>  <em> *</em>
<a name="49" href="#49">49</a>  <em> * &lt;pre></em>
<a name="50" href="#50">50</a>  <em> *  &amp;lt;dependency></em>
<a name="51" href="#51">51</a>  <em> *      &amp;lt;groupId>org.apache.ant&amp;lt;/groupId></em>
<a name="52" href="#52">52</a>  <em> *      &amp;lt;artifactId>ant&amp;lt;/artifactId></em>
<a name="53" href="#53">53</a>  <em> *      &amp;lt;version>1.7.0&amp;lt;/version></em>
<a name="54" href="#54">54</a>  <em> *  &amp;lt;/dependency></em>
<a name="55" href="#55">55</a>  <em> * &lt;/pre></em>
<a name="56" href="#56">56</a>  <em> *</em>
<a name="57" href="#57">57</a>  <em> * @author mikenereson</em>
<a name="58" href="#58">58</a>  <em> */</em>
<a name="59" href="#59">59</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../com/seventytwomiles/architecturerules/ant/AssertArchitectureTask.html">AssertArchitectureTask</a> <strong>extends</strong> Task {
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>  
<a name="62" href="#62">62</a>      <em>/**<em>*</em></em>
<a name="63" href="#63">63</a>  <em>     * &lt;p>The name of the configuration file that is in the classpath that holds</em>
<a name="64" href="#64">64</a>  <em>     * the xml configuration. Recommend &lt;samp>architecture-rules.xml&lt;/samp>&lt;/p></em>
<a name="65" href="#65">65</a>  <em>     *</em>
<a name="66" href="#66">66</a>  <em>     * @parameter configurationFileName String</em>
<a name="67" href="#67">67</a>  <em>     */</em>
<a name="68" href="#68">68</a>      <strong>private</strong> String configurationFileName;
<a name="69" href="#69">69</a>  
<a name="70" href="#70">70</a>      <em>/**<em>*</em></em>
<a name="71" href="#71">71</a>  <em>     * &lt;p>Reference the configuration that is built by the</em>
<a name="72" href="#72">72</a>  <em>     * &lt;code>ConfiguraitonFactory&lt;/code> that reads the configurationFile. This</em>
<a name="73" href="#73">73</a>  <em>     * configuration may be modified.&lt;/p></em>
<a name="74" href="#74">74</a>  <em>     *</em>
<a name="75" href="#75">75</a>  <em>     * @parameter configuration Configuration</em>
<a name="76" href="#76">76</a>  <em>     */</em>
<a name="77" href="#77">77</a>      <strong>final</strong> <strong>private</strong> <a href="../../../../com/seventytwomiles/architecturerules/configuration/Configuration.html">Configuration</a> configuration = <strong>new</strong> <a href="../../../../com/seventytwomiles/architecturerules/configuration/Configuration.html">Configuration</a>();
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <em>/**<em>*</em></em>
<a name="81" href="#81">81</a>  <em>     * Setter for property 'configurationFileName'.</em>
<a name="82" href="#82">82</a>  <em>     *</em>
<a name="83" href="#83">83</a>  <em>     * @param configurationFileName Value to set for property</em>
<a name="84" href="#84">84</a>  <em>     * 'configurationFileName'.</em>
<a name="85" href="#85">85</a>  <em>     */</em>
<a name="86" href="#86">86</a>      <strong>public</strong> <strong>void</strong> setConfigurationFileName(<strong>final</strong> String configurationFileName) {
<a name="87" href="#87">87</a>          <strong>this</strong>.configurationFileName = configurationFileName;
<a name="88" href="#88">88</a>      }
<a name="89" href="#89">89</a>  
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>      <em>/**<em>*</em></em>
<a name="92" href="#92">92</a>  <em>     * @throws BuildException</em>
<a name="93" href="#93">93</a>  <em>     * @see Task#execute()</em>
<a name="94" href="#94">94</a>  <em>     */</em>
<a name="95" href="#95">95</a>      @Override
<a name="96" href="#96">96</a>      <strong>public</strong> <strong>void</strong> execute() throws BuildException {
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>          <strong>super</strong>.execute();
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>         <strong>if</strong> (<strong>null</strong> == configurationFileName || <span class="string">""</span>.equals(configurationFileName))
<a name="101" href="#101">101</a>             <strong>throw</strong> <strong>new</strong> IllegalStateException(
<a name="102" href="#102">102</a>                     <span class="string">"set configurationFileName property"</span>);
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>         <em>/**<em>*</em></em>
<a name="105" href="#105">105</a> <em>         * 1. load configuration</em>
<a name="106" href="#106">106</a> <em>         */</em>
<a name="107" href="#107">107</a>         <strong>final</strong> <a href="../../../../com/seventytwomiles/architecturerules/configuration/ConfigurationFactory.html">ConfigurationFactory</a> configurationFactory
<a name="108" href="#108">108</a>                 = <strong>new</strong> <a href="../../../../com/seventytwomiles/architecturerules/configuration/xml/DigesterConfigurationFactory.html">DigesterConfigurationFactory</a>(configurationFileName);
<a name="109" href="#109">109</a> 
<a name="110" href="#110">110</a>         <strong>this</strong>.configuration.getRules().addAll(configurationFactory.getRules());
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>         <strong>this</strong>.configuration
<a name="113" href="#113">113</a>                 .getSources().addAll(configurationFactory.getSources());
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>         <strong>this</strong>.configuration.setDoCyclicDependencyTest(
<a name="116" href="#116">116</a>                 configurationFactory.doCyclicDependencyTest());
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>         <strong>this</strong>.configuration.setThrowExceptionWhenNoPackages(
<a name="119" href="#119">119</a>                 configurationFactory.throwExceptionWhenNoPackages());
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>         <em>/**<em>*</em></em>
<a name="122" href="#122">122</a> <em>         * 2. assert configuration rules</em>
<a name="123" href="#123">123</a> <em>         */</em>
<a name="124" href="#124">124</a>         <a href="../../../../com/seventytwomiles/architecturerules/configuration/Configuration.html">Configuration</a> configuration
<a name="125" href="#125">125</a>                 = <strong>new</strong> <a href="../../../../com/seventytwomiles/architecturerules/configuration/UnmodifiableConfiguration.html">UnmodifiableConfiguration</a>(<strong>this</strong>.configuration);
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>         <strong>final</strong> <a href="../../../../com/seventytwomiles/architecturerules/services/RulesService.html">RulesService</a> rulesService
<a name="128" href="#128">128</a>                 = <strong>new</strong> <a href="../../../../com/seventytwomiles/architecturerules/services/RulesServiceImpl.html">RulesServiceImpl</a>(configuration);
<a name="129" href="#129">129</a> 
<a name="130" href="#130">130</a>         rulesService.performRulesTest();
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>         <em>/**<em>*</em></em>
<a name="133" href="#133">133</a> <em>         * 3. check for cyclic dependency, if requested</em>
<a name="134" href="#134">134</a> <em>         */</em>
<a name="135" href="#135">135</a>         <strong>if</strong> (<strong>this</strong>.configuration.shouldDoCyclicDependencyTest()) {
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a>             configuration = <strong>new</strong> <a href="../../../../com/seventytwomiles/architecturerules/configuration/UnmodifiableConfiguration.html">UnmodifiableConfiguration</a>(<strong>this</strong>.configuration);
<a name="138" href="#138">138</a> 
<a name="139" href="#139">139</a>             <strong>final</strong> <a href="../../../../com/seventytwomiles/architecturerules/services/CyclicRedundancyService.html">CyclicRedundancyService</a> redundancyService
<a name="140" href="#140">140</a>                     = <strong>new</strong> <a href="../../../../com/seventytwomiles/architecturerules/services/CyclicRedundancyServiceImpl.html">CyclicRedundancyServiceImpl</a>(configuration);
<a name="141" href="#141">141</a> 
<a name="142" href="#142">142</a>             redundancyService.performCyclicRedundancyCheck();
<a name="143" href="#143">143</a>         }
<a name="144" href="#144">144</a>     }
<a name="145" href="#145">145</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

